Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DOCS: use nbsphinx-link and include myst beta #219

Merged
merged 11 commits into from
Nov 3, 2024
Merged

DOCS: use nbsphinx-link and include myst beta #219

merged 11 commits into from
Nov 3, 2024

Conversation

knaaptime
Copy link
Member

@knaaptime knaaptime commented Oct 30, 2024 •
edited
Loading

this resolves the issues the the docs (locally anyway):

  • fixes the bib not rendering
  • uses nbsphinx-link (correctly this time, because the makefile no longer interferes)
  • includes a beta of myst and autodoc2. This isn't exposed yet as a link but will be rendered at pysal.org/tobler/apimyst for comparison when the docs are built
    • I don't love the style, but I hate RST and maybe numpydoc style will be supported in the future
    • this required making the private/public functions more explicit using __all__ throughout

@knaaptime knaaptime assigned jGaboardi and unassigned jGaboardi Oct 30, 2024
@knaaptime knaaptime requested a review from jGaboardi October 30, 2024 23:52
@jGaboardi
Copy link
Member

@knaaptime And the macOS13 failure is ongoing for awhile now so we don't have worry about here, right?

@jGaboardi jGaboardi requested a review from gegen07 October 31, 2024 01:01
@knaaptime
Copy link
Member Author

yeah the failure at the moment is actually a codecov timeout or something

@jGaboardi
Copy link
Member

Is there a preview somewhere that is rendered?

@knaaptime
Copy link
Member Author

if you build locally and launch a webserver in side the _html dir, its the apimyst.html page
Screenshot 2024-10-30 at 6 13 37 PM
Screenshot 2024-10-30 at 6 13 14 PM

jGaboardi
jGaboardi reviewed Oct 31, 2024
View reviewed changes
docs/apimyst.md Outdated Show resolved Hide resolved
docs/apimyst.md Outdated Show resolved Hide resolved
docs/apimyst.md Outdated Show resolved Hide resolved
knaaptime and others added 6 commits October 31, 2024 08:17
@knaaptime @jGaboardi
Update docs/apimyst.md
090c25b 
Co-authored-by: James Gaboardi <jgaboardi@gmail.com>
@knaaptime @jGaboardi
Update docs/apimyst.md
01a6ea2 
Co-authored-by: James Gaboardi <jgaboardi@gmail.com>
bump ci envs
c3824c0
cis
f35e9f1
h3 pins
707bafe
@knaaptime @jGaboardi
Update docs/apimyst.md
dff913e 
Co-authored-by: James Gaboardi <jgaboardi@gmail.com>
@jGaboardi
Copy link
Member

Windows failure is a bit cryptic. Any idea what's going on there?

@martinfleis
Copy link
Member

Any idea what's going on there?

ongoing micromamba action issue. ignore it - mamba-org/setup-micromamba#227

@knaaptime knaaptime merged commit dc397ff into pysal:main Nov 3, 2024
5 of 7 checks passed
@knaaptime
Copy link
Member Author

you can see the live versions created by autodoc2 at https://pysal.org/tobler/apimyst.html and https://pysal.org/tobler/apidocs

This was referenced Nov 3, 2024
Closed
Closed
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jGaboardi jGaboardi jGaboardi approved these changes

@sjsrey sjsrey sjsrey approved these changes

@martinfleis martinfleis Awaiting requested review from martinfleis

@gegen07 gegen07 Awaiting requested review from gegen07

Assignees
No one assigned
Labels
ci/testing maint
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@knaaptime @jGaboardi @martinfleis @sjsrey